API docs by RedoclyMarketplace API (1.0.0)
Download OpenAPI specification:Download
An API for the Marketplace application
Create a product
Create a product to sell. Using the product name, description, condition, category and price
Request Body schema: application/json
The products information
|
description
required
|
string
<=
700 characters
A 700 character description of the product |
|
name
required
|
string
The name of the product |
|
price
required
|
integer
The price of the product |
|
condition
required
|
string
A description of the condition of the product |
|
category
required
|
string
The category the product belongs in |
Responses
Request samples
- Payload
{
-
"description":
"string",
-
"name":
"string",
-
"price":
0,
-
"condition":
"string",
-
"category":
"string"
}
Response samples
- 200
{
-
"owner":
"string",
-
"description":
"string",
-
"itemNumber":
"string",
-
"imagePaths":
[
-
"string"
],
-
"name":
"string",
-
"price":
0,
-
"condition":
"string",
-
"category":
"string",
-
"sold":
true
}
Query products
Query the catalog of products
query Parameters
| query |
string
A query to match |
| limit |
integer
The limit of products returned |
| sortBy |
string
The sorting order |
Responses
Response samples
- 200
{
-
"owner":
"string",
-
"description":
"string",
-
"itemNumber":
"string",
-
"imagePaths":
[
-
"string"
],
-
"name":
"string",
-
"price":
0,
-
"condition":
"string",
-
"category":
"string",
-
"sold":
true
}
Delete a product
Authorizations:
path Parameters
|
itemNumber
required
|
string
Product's reference |
Responses
Response samples
- 200
{
-
"owner":
"string",
-
"description":
"string",
-
"itemNumber":
"string",
-
"imagePaths":
[
-
"string"
],
-
"name":
"string",
-
"price":
0,
-
"condition":
"string",
-
"category":
"string",
-
"sold":
true
}
Sell a product
Will set a products as sold
Authorizations:
path Parameters
|
itemNumber
required
|
string
Product's reference |
Responses
Response samples
- 200
{
-
"owner":
"string",
-
"description":
"string",
-
"itemNumber":
"string",
-
"imagePaths":
[
-
"string"
],
-
"name":
"string",
-
"price":
0,
-
"condition":
"string",
-
"category":
"string",
-
"sold":
true
}
Update a product
Update one of the product's properties
Authorizations:
path Parameters
|
itemNumber
required
|
string
Product's reference |
Request Body schema: application/json
Choose at least one of the following properties to update
| description |
string
<=
700 characters
A 700 character description of the product |
| name |
string
The name of the product |
| price |
integer
The price of the product |
| condition |
string
A description of the condition of the product |
| category |
string
The category the product belongs in |
Responses
Request samples
- Payload
{
-
"description":
"string",
-
"name":
"string",
-
"price":
0,
-
"condition":
"string",
-
"category":
"string"
}
Response samples
- 200
{
-
"owner":
"string",
-
"description":
"string",
-
"itemNumber":
"string",
-
"imagePaths":
[
-
"string"
],
-
"name":
"string",
-
"price":
0,
-
"condition":
"string",
-
"category":
"string",
-
"sold":
true
}
Get a product
Get a product's inforamtion with the itemNumber
path Parameters
|
itemNumber
required
|
string
Product's reference |
Responses
Response samples
- 200
{
-
"owner":
"string",
-
"description":
"string",
-
"itemNumber":
"string",
-
"imagePaths":
[
-
"string"
],
-
"name":
"string",
-
"price":
0,
-
"condition":
"string",
-
"category":
"string",
-
"sold":
true
}
Get a product's owner
Get information on a product's owner
path Parameters
|
itemNumber
required
|
string
Product's reference |
Responses
Response samples
- 200
{
-
"username":
"string",
-
"imageName":
"string",
-
"arrayOfProducts":
[
-
{
-
"owner":
"string",
-
"description":
"string",
-
"itemNumber":
"string",
-
"imagePaths":
[
-
"string"
],
-
"name":
"string",
-
"price":
0,
-
"condition":
"string",
-
"category":
"string",
-
"sold":
true
}
]
}
Set product image
Set a product's image(s)
Authorizations:
path Parameters
|
itemNumber
required
|
string
Product's reference |
Request Body schema: multipart/form-data
An image url
| file |
Array of strings
<binary>
|
Responses
Response samples
- 200
{
-
"owner":
"string",
-
"description":
"string",
-
"itemNumber":
"string",
-
"imagePaths":
[
-
"string"
],
-
"name":
"string",
-
"price":
0,
-
"condition":
"string",
-
"category":
"string",
-
"sold":
true
}
Delete product image
Delete a product's image(s)
Authorizations:
path Parameters
|
itemNumber
required
|
string
Product's reference |
Request Body schema: application/json
An array of images
A images's name
Responses
Request samples
- Payload
[
-
"string"
]
Response samples
- 200
{
-
"owner":
"string",
-
"description":
"string",
-
"itemNumber":
"string",
-
"imagePaths":
[
-
"string"
],
-
"name":
"string",
-
"price":
0,
-
"condition":
"string",
-
"category":
"string",
-
"sold":
true
}
Read offer
Read an offer made for a product
path Parameters
|
offerRef
required
|
string
An offer for a product |
Responses
Response samples
- 200
{
-
"offerAmount":
0,
-
"productRef":
"string",
-
"reference":
"string",
-
"offerViewed":
true,
-
"offerAccepted":
true,
-
"offerRejected":
true,
-
"offerDate":
"2019-08-24",
-
"message":
"string",
-
"buyerReference":
"string"
}
Response samples
- 200
[
-
{
-
"offerAmount":
0,
-
"productRef":
"string",
-
"reference":
"string",
-
"offerViewed":
true,
-
"offerAccepted":
true,
-
"offerRejected":
true,
-
"offerDate":
"2019-08-24",
-
"message":
"string",
-
"buyerReference":
"string"
}
]
Creat an offer
Create and send an offer to a seller
Request Body schema: application/json
A offer needs only offerAmount, buyerReference, and productRef
| offerAmount |
number
The dollar amount being offered for the product |
| productRef |
string
The identifier for the product |
| buyerReference |
string
A reference to the user sending the offer |
Responses
Request samples
- Payload
{
-
"offerAmount":
0,
-
"productRef":
"string",
-
"buyerReference":
"string"
}
Send a message
Send a message to a seller
Request Body schema: application/json
|
senderRef
required
|
string
The sender's reference (username) |
|
recipientRef
required
|
string
The recipient reference (username) |
|
text
required
|
string
<=
700 characters
The message body |
| date |
string
<date>
The date the message was sent |
Responses
Request samples
- Payload
{
-
"senderRef":
"string",
-
"recipientRef":
"string",
-
"text":
"string",
-
"date":
"2019-08-24"
}
Response samples
- 201
{
-
"senderRef":
"string",
-
"recipientRef":
"string",
-
"text":
"string",
-
"date":
"2019-08-24"
}
Reply to a message
Send a reply to a message
path Parameters
|
messageRef
required
|
string
A message reference |
Request Body schema: application/json
|
senderRef
required
|
string
The sender's reference (username) |
|
recipientRef
required
|
string
The recipient reference (username) |
|
text
required
|
string
<=
700 characters
The message body |
| date |
string
<date>
The date the message was sent |
Responses
Request samples
- Payload
{
-
"senderRef":
"string",
-
"recipientRef":
"string",
-
"text":
"string",
-
"date":
"2019-08-24"
}
Response samples
- 201
{
-
"senderRef":
"string",
-
"recipientRef":
"string",
-
"text":
"string",
-
"date":
"2019-08-24"
}
Create a user
Register a user account
Request Body schema: application/json
|
password
required
|
string
<password>
|
|
username
required
|
string
|
|
email
required
|
string
|
Responses
Request samples
- Payload
{
-
"password":
"pa$$word",
-
"username":
"string",
-
"email":
"string"
}
Response samples
- 200
{
-
"username":
"string",
-
"email":
"user@example.com",
-
"imageName":
"string",
-
"arrayOfProducts":
[
-
{
-
"owner":
"string",
-
"description":
"string",
-
"itemNumber":
"string",
-
"imagePaths":
[
-
"string"
],
-
"name":
"string",
-
"price":
0,
-
"condition":
"string",
-
"category":
"string",
-
"sold":
true
}
],
-
"token":
"string"
}
Update a user
Update a user's username
Authorizations:
Request Body schema: application/json
| username |
string
|
Responses
Request samples
- Payload
{
-
"username":
"string"
}
Response samples
- 200
{
-
"username":
"string",
-
"email":
"user@example.com",
-
"imageName":
"string",
-
"arrayOfProducts":
[
-
{
-
"owner":
"string",
-
"description":
"string",
-
"itemNumber":
"string",
-
"imagePaths":
[
-
"string"
],
-
"name":
"string",
-
"price":
0,
-
"condition":
"string",
-
"category":
"string",
-
"sold":
true
}
],
-
"token":
"string"
}
Log a user in
Log a user in using email and password
Request Body schema: application/json
| password |
string
<password>
|
|
string
|
Responses
Request samples
- Payload
{
-
"password":
"pa$$word",
-
"email":
"string"
}
Response samples
- 200
{
-
"username":
"string",
-
"email":
"user@example.com",
-
"imageName":
"string",
-
"arrayOfProducts":
[
-
{
-
"owner":
"string",
-
"description":
"string",
-
"itemNumber":
"string",
-
"imagePaths":
[
-
"string"
],
-
"name":
"string",
-
"price":
0,
-
"condition":
"string",
-
"category":
"string",
-
"sold":
true
}
],
-
"token":
"string"
}
Get the public information for a user
Get username, image, and product's from a user
path Parameters
|
username
required
|
string
<username>
The user's username |
Responses
Response samples
- 200
{
-
"username":
"string",
-
"imageName":
"string",
-
"arrayOfProducts":
[
-
{
-
"owner":
"string",
-
"description":
"string",
-
"itemNumber":
"string",
-
"imagePaths":
[
-
"string"
],
-
"name":
"string",
-
"price":
0,
-
"condition":
"string",
-
"category":
"string",
-
"sold":
true
}
]
}
Get a product's owner
Get information on a product's owner
path Parameters
|
itemNumber
required
|
string
Product's reference |
Responses
Response samples
- 200
{
-
"username":
"string",
-
"imageName":
"string",
-
"arrayOfProducts":
[
-
{
-
"owner":
"string",
-
"description":
"string",
-
"itemNumber":
"string",
-
"imagePaths":
[
-
"string"
],
-
"name":
"string",
-
"price":
0,
-
"condition":
"string",
-
"category":
"string",
-
"sold":
true
}
]
}
Set user's image
Set a user's image(s)
Authorizations:
Request Body schema: multipart/form-data
An image url
| file |
Array of strings
<binary>
|
Responses
Response samples
- 200
{
-
"username":
"string",
-
"email":
"user@example.com",
-
"imageName":
"string",
-
"arrayOfProducts":
[
-
{
-
"owner":
"string",
-
"description":
"string",
-
"itemNumber":
"string",
-
"imagePaths":
[
-
"string"
],
-
"name":
"string",
-
"price":
0,
-
"condition":
"string",
-
"category":
"string",
-
"sold":
true
}
],
-
"token":
"string"
}
Delete user image
Delete a user's image(s)
Authorizations:
Request Body schema: application/json
An array of images
A images's name
Responses
Request samples
- Payload
[
-
"string"
]
Response samples
- 200
{
-
"username":
"string",
-
"email":
"user@example.com",
-
"imageName":
"string",
-
"arrayOfProducts":
[
-
{
-
"owner":
"string",
-
"description":
"string",
-
"itemNumber":
"string",
-
"imagePaths":
[
-
"string"
],
-
"name":
"string",
-
"price":
0,
-
"condition":
"string",
-
"category":
"string",
-
"sold":
true
}
],
-
"token":
"string"
}
Set user's image
Set a user's image(s)
Authorizations:
Request Body schema: multipart/form-data
An image url
| file |
Array of strings
<binary>
|
Responses
Response samples
- 200
{
-
"username":
"string",
-
"email":
"user@example.com",
-
"imageName":
"string",
-
"arrayOfProducts":
[
-
{
-
"owner":
"string",
-
"description":
"string",
-
"itemNumber":
"string",
-
"imagePaths":
[
-
"string"
],
-
"name":
"string",
-
"price":
0,
-
"condition":
"string",
-
"category":
"string",
-
"sold":
true
}
],
-
"token":
"string"
}
Delete user image
Delete a user's image(s)
Authorizations:
Request Body schema: application/json
An array of images
A images's name
Responses
Request samples
- Payload
[
-
"string"
]
Response samples
- 200
{
-
"username":
"string",
-
"email":
"user@example.com",
-
"imageName":
"string",
-
"arrayOfProducts":
[
-
{
-
"owner":
"string",
-
"description":
"string",
-
"itemNumber":
"string",
-
"imagePaths":
[
-
"string"
],
-
"name":
"string",
-
"price":
0,
-
"condition":
"string",
-
"category":
"string",
-
"sold":
true
}
],
-
"token":
"string"
}
Set product image
Set a product's image(s)
Authorizations:
path Parameters
|
itemNumber
required
|
string
Product's reference |
Request Body schema: multipart/form-data
An image url
| file |
Array of strings
<binary>
|
Responses
Response samples
- 200
{
-
"owner":
"string",
-
"description":
"string",
-
"itemNumber":
"string",
-
"imagePaths":
[
-
"string"
],
-
"name":
"string",
-
"price":
0,
-
"condition":
"string",
-
"category":
"string",
-
"sold":
true
}
Delete product image
Delete a product's image(s)
Authorizations:
path Parameters
|
itemNumber
required
|
string
Product's reference |
Request Body schema: application/json
An array of images
A images's name
Responses
Request samples
- Payload
[
-
"string"
]
Response samples
- 200
{
-
"owner":
"string",
-
"description":
"string",
-
"itemNumber":
"string",
-
"imagePaths":
[
-
"string"
],
-
"name":
"string",
-
"price":
0,
-
"condition":
"string",
-
"category":
"string",
-
"sold":
true
}